MSG

# 43. logging模块 - 日志模块

# logging日志模块

# logging能或不能做的事

logging模块能帮你做的事

  1. 日志格式的规范生成
  2. 操作的简化
  3. 日志的等级管理

logging模块不能帮你做的事

  1. logging模块不会自动生成你要打印的内容
  2. logging模块需要程序员在开发的时候定义好
    1. 那些地址需要打印
    2. 那些地方无需打印到文件里
    3. 那些地址无需打印到当前屏幕里
    4. 要打印的内容是什么
    5. 要打印的内容级别

# logging模块的二种模式

logging模块分为二种模式

  1. 普通配置型
    1. 简单化
    2. 但是可定制化差
  2. 对象配置型
    1. 复杂化
    2. 但是可定制强

# logging模块的日志等级

从高到低

  1. critical ：严重错误级
  2. error：错误级
  3. warning：警告级
  4. info：基础信息级
  5. debug：调试模式级

logging模块默认显示警告级以上的日志信息，就是说info跟debug二个日志信息是默认不会显示

但是可以修改在可以显示，接下来会说

# 普通配置型

# logging模块中basicConfig详细

logging.basicConfig()：函数中可通过具体参数来更改logging模块默认行为

  1. filename：用指定的文件名创建FiledHandler，这样日志会被存储在指定的文件中。
  2. filemode：文件打开方式，在指定了filename时使用这个参数，默认值为“a”还可指定为“w”。
  3. format：指定handler使用的日志显示格式。
    1. %(name)s Logger的名字
    2. %(levelno)s 数字形式的日志级别
    3. %(levelname)s 文本形式的日志级别
    4. %(pathname)s 调用日志输出函数的模块的完整路径名，可能没有
    5. %(filename)s 调用日志输出函数的模块的文件名
    6. %(module)s 调用日志输出函数的模块名
    7. %(funcName)s 调用日志输出函数的函数名
    8. %(lineno)d 调用日志输出函数的语句所在的代码行
    9. %(created)f 当前时间，用UNIX标准的表示时间的浮 点数表示
    10. %(relativeCreated)d 输出日志信息时的，自Logger创建以 来的毫秒数
    11. %(asctime)s 字符串形式的当前时间。默认格式是 “2003-07-08 16:49:45,896”。逗号后面的是毫秒
    12. %(thread)d 线程ID。可能没有
    13. %(threadName)s 线程名。可能没有
    14. %(process)d 进程ID。可能没有
    15. %(message)s用户输出的消息
  4. datefmt：指定日期时间格式。
  5. level：设置rootlogger（后边会讲解具体概念）的日志级别
  6. stream：用指定的stream创建StreamHandler。可以指定输出到sys.stderr,sys.stdout或者文件(f=open(‘test.log’,’w’))，默认为sys.stderr。若同时列出了filename和stream两个参数，则stream参数会被忽略。

# 简单使用

import logging
logging.basicConfig(
    format='%(asctime)s - %(name)s - %(levelname)s -%(module)s:  %(message)s',
    datefmt='%Y-%m-%d %H:%M:%S %p',
)
logging.debug('debug message')      # 调试模式
logging.info('info message')        # 基础信息
logging.warning('warning message')  # 警告
logging.error('error message')      # 错误
logging.critical('critical message')# 严重错误

执行结果：
2019-09-25 17:28:31 PM - root - WARNING -logging模块:  warning message
2019-09-25 17:28:31 PM - root - ERROR -logging模块:  error message
2019-09-25 17:28:31 PM - root - CRITICAL -logging模块:  critical message
            
## 没有info跟debug的信息，logging默认是不显示

# 显示info跟debug级别的信息

只要在加上level=logging.DEBUG选项就能显示出来

## level=logging.DEBUG 显示DEBUG级别以上的所有信息
## DEBUG级别就是最低的，所以就是显示所有级别的信息
import logging
logging.basicConfig(level=logging.DEBUG,
    format='%(asctime)s - %(name)s - %(levelname)s -%(module)s:  %(message)s',
    datefmt='%Y-%m-%d %H:%M:%S %p',
)
执行结果：
2019-09-25 17:34:01 PM - root - DEBUG -logging模块:  debug message
2019-09-25 17:34:01 PM - root - INFO -logging模块:  info message
2019-09-25 17:34:01 PM - root - WARNING -logging模块:  warning message
2019-09-25 17:34:01 PM - root - ERROR -logging模块:  error message
2019-09-25 17:34:01 PM - root - CRITICAL -logging模块:  critical message


## level=logging.INFO 显示INFO级别以上的所有信息，就是DEBUG级别不显示，其他都显示
import logging
logging.basicConfig(level=logging.DEBUG,
    format='%(asctime)s - %(name)s - %(levelname)s -%(module)s:  %(message)s',
    datefmt='%Y-%m-%d %H:%M:%S %p',
)
执行结果：
2019-09-25 17:33:24 PM - root - INFO -logging模块:  info message
2019-09-25 17:33:24 PM - root - WARNING -logging模块:  warning message
2019-09-25 17:33:24 PM - root - ERROR -logging模块:  error message
2019-09-25 17:33:24 PM - root - CRITICAL -logging模块:  critical message

# 将日志输出到一个文件里

import logging
logging.basicConfig(level=logging.DEBUG,filename='logging.log',
    format='%(asctime)s - %(name)s - %(levelname)s -%(module)s:  %(message)s',
    datefmt='%Y-%m-%d %H:%M:%S %p',
)
logging.debug('debug message')      # 调试模式
logging.info('info message')        # 基础信息
logging.warning('warning message')  # 警告
logging.error('error message')      # 错误
logging.critical('critical message')# 严重错误

执行结果，文件内容：
2019-09-25 17:45:33 PM - root - DEBUG -loggingģ��:  debug message
2019-09-25 17:45:33 PM - root - INFO -loggingģ��:  info message
2019-09-25 17:45:33 PM - root - WARNING -loggingģ��:  warning message
2019-09-25 17:45:33 PM - root - ERROR -loggingģ��:  error message
2019-09-25 17:45:33 PM - root - CRITICAL -loggingģ��:  critical message

# 解决中文输出乱码

import logging
file_handler = logging.FileHandler(filename='logging.log', mode='a', encoding='utf-8',)
logging.basicConfig(
    format='%(asctime)s - %(name)s - %(levelname)s -%(module)s:  %(message)s',
    datefmt='%Y-%m-%d %H:%M:%S %p',
    level=logging.DEBUG,handlers=[file_handler,])
logging.debug('debug message')      # 调试模式
logging.info('info message')        # 基础信息
logging.warning('warning message')  # 警告
logging.error('error message')      # 错误
logging.critical('critical message')# 严重错误

执行结果，文件内容：
2019-09-25 17:58:41 PM - root - DEBUG -logging模块:  debug message
2019-09-25 17:58:41 PM - root - INFO -logging模块:  info message
2019-09-25 17:58:41 PM - root - WARNING -logging模块:  warning message
2019-09-25 17:58:41 PM - root - ERROR -logging模块:  error message
2019-09-25 17:58:41 PM - root - CRITICAL -logging模块:  critical message

# 日志分割 -- 有需要在来研究

import time
import logging
from logging import handlers

sh = logging.StreamHandler()
rh = handlers.RotatingFileHandler('myapp.log', maxBytes=1024,backupCount=5)
fh = handlers.TimedRotatingFileHandler(filename='x2.log', when='s', interval=5, encoding='utf-8')
logging.basicConfig(
    format='%(asctime)s - %(name)s - %(levelname)s -%(module)s:  %(message)s',
    datefmt='%Y-%m-%d %H:%M:%S %p',
    handlers=[fh,sh,rh],
    level=logging.ERROR
)

for i in range(1,100000):
    time.sleep(1)
    logging.error('KeyboardInterrupt error %s'%str(i))

# 对象配置型

# 对象配置型的配置顺序

创建

  1. 创建一个对象(实例化logging模块中的getLogger()类)
  2. 创建一个文件管理操作符
  3. 创建一个屏幕管理操作符
  4. 创建一个日志输出的格式

格式绑定

  1. 文件管理操作符 绑定 日志格式
  2. 屏幕管理操作符 绑定 日志格式

输出绑定

  1. 创建好的对象 绑定 文件管理操作符
  2. 创建好的对象 绑定 屏幕管理操作符

注意：

  1. 一个文件管理操作符，就代表一个文件
  2. 文件或屏幕管理操作符只能绑定一个日志格式，不能绑定多个日志格式
    1. 文件或屏幕管理操作符可以分别绑定不同的日志格式
    2. 但是就只能绑定一个日志格式
  3. 对象输出可以绑定多个管理操作符
    1. 对象输出可以绑定多个文件管理操作符

# 对象配置型的使用

import logging
## 创建一个对象(实例化logging模块中的getLogger()类)
logger = logging.getLogger()
## 创建一个文件管理操作符
fh = logging.FileHandler("logging.log",encoding="utf-8")
## 创建一个屏幕管理操作符
sh = logging.StreamHandler()
## 创建一个日志输出的格式
journal1 = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
## 文件管理操作符 绑定 日志格式
fh.setFormatter(journal1)
## 屏幕管理操作符 绑定 日志格式
sh.setFormatter(journal1)
## 设置日志输出等级
logger.setLevel(logging.DEBUG)
## 创建好的对象 绑定 文件管理操作符
logger.addHandler(fh)
## 创建好的对象 绑定 屏幕管理操作符
logger.addHandler(sh)

logger.debug('debug message')      # 调试模式
logger.info('中国')        # 基础信息
logger.warning('warning message')  # 警告
logger.error('error message')      # 错误
logger.critical('critical message')# 严重错误

执行结果：
2019-09-26 10:54:18,411 - root - DEBUG - debug message
2019-09-26 10:54:18,412 - root - INFO - 中国
2019-09-26 10:54:18,412 - root - WARNING - warning message
2019-09-26 10:54:18,412 - root - ERROR - error message
2019-09-26 10:54:18,412 - root - CRITICAL - critical message
        
日志文件内容：
2019-09-26 10:54:18,411 - root - DEBUG - debug message
2019-09-26 10:54:18,412 - root - INFO - 中国
2019-09-26 10:54:18,412 - root - WARNING - warning message
2019-09-26 10:54:18,412 - root - ERROR - error message
2019-09-26 10:54:18,412 - root - CRITICAL - critical message

← 44. 异常处理 →